---
title: CLI 命令
---

import Since from '~/components/Since.astro';
import PackageManagerTabs from '~/components/tabs/PackageManagerTabs.astro'
import ReadMore from '~/components/ReadMore.astro'

你可以使用 Astro 提供的命令行界面 (CLI) 从终端窗口开发、构建和预览你的项目。

### `astro` 命令

通过使用你喜欢的包管理器运行此页面上记录的**命令**之一来使用 CLI，可选择后跟任何**标志**。标志可以自定义命令的行为。

你最常使用的命令之一是 `astro dev`。这个命令启动开发服务器，并在浏览器中为你提供一个实时更新的网站预览，以便你在工作时查看。

<PackageManagerTabs>
  <Fragment slot="npm">
  ```shell
  # 启动开发服务器
  npx astro dev
  ```
  </Fragment>
  <Fragment slot="pnpm">
  ```shell
  # 启动开发服务器
  pnpm astro dev
  ```
  </Fragment>
  <Fragment slot="yarn">
  ```shell
  # 启动开发服务器
  yarn astro dev
  ```
  </Fragment>
</PackageManagerTabs>

你可以在终端中输入 `astro --help` 来显示所有可用命令的列表：

<PackageManagerTabs>
  <Fragment slot="npm">
  ```shell
  npx astro --help
  ```
  </Fragment>
  <Fragment slot="pnpm">
  ```shell
  pnpm astro --help
  ```
  </Fragment>
  <Fragment slot="yarn">
  ```shell
  yarn astro --help
  ```
  </Fragment>
</PackageManagerTabs>

下面的消息将在你的终端中显示：

```bash
astro [command] [...flags]

Commands
              add  Add an integration.
            build  Build your project and write it to disk.
            check  Check your project for errors.
              dev  Start the development server.
             docs  Open documentation in your web browser.
             info  List info about your current Astro setup.
          preview  Preview your build locally.
             sync  Generate content collection types.
      preferences  Configure user preferences.
        telemetry  Configure telemetry settings.

Global Flags
  --config <path>  Specify your config file.
    --root <path>  Specify your project root folder.
     --site <url>  Specify your project site.
--base <pathname>  Specify your project base.
        --verbose  Enable verbose logging.
         --silent  Disable all logging.
        --version  Show the version number and exit.
           --open  Open the app in the browser on server start.
           --help  Show this help message.
```

:::note
你需要在标志前添加 `--` 才能让 `npm` 把这些标志传递给 `astro` 命令。
:::

### `package.json` 脚本

你也可以在 `package.json` 中使用脚本来使用这些命令的简短版本。使用脚本允许你使用来自其他项目的相同命令，例如 `npm run build`。

当你使用 [`create astro` 向导](/zh-cn/install/auto/#1-运行安装向导) 创建项目时，以下脚本是为你自动添加的，用于最常用的 `astro` 命令（`astro dev`、`astro build` 和 `astro preview`）。

当你按照[手动安装 Astro](/zh-cn/install/manual/#2-安装-astro) 的说明进行操作时，你会被告知自己添加这些脚本。你还可以手动为任何你经常使用的命令添加更多脚本到这个列表中。

```json title="package.json"
{
  "scripts": {
    "dev": "astro dev",
    "start": "astro dev",
    "build": "astro build",
    "preview": "astro preview"
  }
}
```

你经常会使用这些 `astro` 命令，或者运行它们的脚本，而不带任何标志。当你想要自定义命令的行为时，可以向命令添加标志。例如，你可能希望在不同的端口上启动开发服务器，或者使用详细日志构建站点以进行调试。

<PackageManagerTabs>
  <Fragment slot="npm">
  ```shell
  # 使用 `package.json` 中的 `start` 脚本，以端口 8080 启动开发服务器
  npm run start -- --port 8080

  # 使用 `package.json` 中的 `build` 脚本，构建带有详细日志的网站
  npm run build -- --verbose
  ```
  </Fragment>
  <Fragment slot="pnpm">
  ```shell
  # 使用 `package.json` 中的 `start` 脚本，以端口 8080 启动开发服务器
  pnpm start --port 8080

  # 使用 `package.json` 中的 `build` 脚本，构建带有详细日志的网站
  pnpm build --verbose
  ```
  </Fragment>
  <Fragment slot="yarn">
  ```shell
  # 使用 `package.json` 中的 `start` 脚本，以端口 8080 启动开发服务器
  yarn start --port 8080

  # 使用 `package.json` 中的 `build` 脚本，构建带有详细日志的网站
  yarn build --verbose
  ```
  </Fragment>
</PackageManagerTabs>

## `astro dev`

运行 Astro 的开发服务器。这是一个不打包资源的本地 HTTP 服务器。当你在编辑器中保存更改时，它使用热模块替换 (HMR) 来更新你的浏览器。

## `astro build`

构建你的网站以进行部署。默认情况下，这将生成静态文件并将它们放在 `dist/` 目录中。如果[SSR 被启用](/zh-cn/guides/server-side-rendering/)，这将生成必要的服务器文件为你的网站提供服务。


可以与下面记录的[通用标志](#通用标志)结合使用。

## `astro preview`

启动一个本地服务器，用于提供由运行 `astro build` 创建的静态目录（默认为 `dist/`）的内容。

该命令允许你在部署之前[构建](#astro-build)本地预览你的网站，以便在构建输出中捕获任何错误。它不是为在生产环境中运行而设计的。有关生产托管的帮助，请查看我们的[部署 Astro 网站](/zh-cn/guides/deploy/)指南。

从 Astro 1.5.0 开始，如果你使用支持它的适配器，`astro preview` 也适用于 SSR 构建。目前，只有 [Node 适配器](/zh-cn/guides/integrations-guide/node/)支持 `astro preview`。

可以与下面文档的[通用标志](#通用标志)结合使用。

## `astro check`

对项目进行检测（比如对 `.astro` 文件进行类型检查），并向控制台输出错误信息。如果发现任何错误，该进程将以 **1** 代码退出。

该命令旨在用于 CI 工作流程。

<h3>标志</h3>

使用这些标志来自定义命令的行为。

#### `--watch`

该命令将监听你项目中的任何更改，并报告任何错误。

<ReadMore>阅读更多关于 [在 Astro 中类型检查](/zh-cn/guides/typescript/) 的信息。</ReadMore>

## `astro sync`

<p><Since v="2.0.0" /></p>

:::tip
运行 `astro dev`，`astro build`或者`astro check`也会运行`sync`命令。
:::

为所有 Astro 模块生成 TypeScript 类型。这会为类型推断设置一个[`src/env.d.ts`文件](/zh-cn/guides/typescript/#设置)，并为依赖于生成类型的特性定义模块：

- `astro:content` 模块用于 [内容集合 API](/zh-cn/guides/content-collections/)。
- `astro:db` 模块用于 [Astro DB](/zh-cn/guides/astro-db/)。

## `astro add`

将集成添加到你的配置中。在[集成指南](/zh-cn/guides/integrations-guide/#自动集成设置)中阅读更多信息。

## `astro docs`

直接从终端启动 Astro Docs 网站。

## `astro info`

显示当前 Astro 环境的有用信息，以便在提交 issue 时提供信息。

```shell
astro info
```

输出示例：

```
Astro version            v2.6.6
Package manager          pnpm
Platform                 darwin
Architecture             arm64
Adapter                  @astrojs/vercel/serverless
Integrations             none
```

## `astro preferences`

使用 `astro preferences` 命令管理用户偏好。用户偏好是特定于单个 Astro 用户的，不像 `astro.config.mjs` 文件，它会改变所有项目的所有人的行为。

默认情况下，用户偏好是针对当前项目的，存储在本地的 `.astro/settings.json` 文件中。

使用 `--global` 标志，用户偏好也可以应用于当前机器上的每个 Astro 项目。全局用户偏好存储在特定于操作系统的位置。

举个例子，要在特定的 Astro 项目中禁用 devToolbar：

```shell
astro preferences disable devToolbar
```

要在当前机器上的所有 Astro 项目中禁用 devToolbar：

```shell
astro preferences disable --global devToolbar
```

稍后可以使用以下命令启用 devToolbar：

```shell
astro preferences enable devToolbar
```

`reset` 命令将偏好重置为其默认值：

```shell
astro preferences reset devToolbar
```

`list` 命令打印所有可配置用户偏好的当前设置。它还支持机器可读的 `--json` 输出。

```shell
astro preferences list
```

## `astro telemetry`

为当前 CLI 用户设置遥测配置。遥测是匿名数据，可让 Astro 团队深入了解最常使用哪些 Astro 功能。有关更多信息，请参阅 [Astro 的遥测页面](https://astro.build/telemetry/)。

可以通过这个 CLI 命令禁用遥测：

```shell
astro telemetry disable
```

后面也可以随时通过以下方式重新启用遥测：

```shell
astro telemetry enable
```

使用 `reset` 命令重置遥测数据：

```shell
astro telemetry reset
```

:::tip[想要在 CI 环境中禁用遥测？]
将 `astro telemetry disable` 命令添加到你的 CI 脚本或设置 `ASTRO_TELEMETRY_DISABLED` 环境变量。
:::

## 通用标志

### `--root <path>`

指定项目根目录的路径。如果不指定，则假定当前工作目录为根目录。

根目录是用来寻找 Astro 配置文件的。

```shell
astro --root myRootFolder/myProjectFolder dev
```

### `--config <path>`

指定配置文件的路径。默认为 `astro.config.mjs`。如果使用了不同的配置文件名称或放在其他文件夹中，请使用：

```shell
astro --config config/astro.config.mjs dev
```

### `--outDir <path>`

<p><Since v="3.3.0" /></p>

为你的项目配置 [`outDir`](/zh-cn/reference/configuration-reference/#outdir)。传递此标志将覆盖 `astro.config.mjs` 文件中的 `outDir` 值（如果存在）。

### `--site  <url>`

为你的项目配置 [`site`](/zh-cn/reference/configuration-reference/#base)。传递此标志将覆盖 `astro.config.mjs` 文件中的 `site` 值（如果存在）。

### `--base <pathname>`

<p><Since v="1.4.1" /></p>

为你的项目配置 [`base`](/zh-cn/reference/configuration-reference/#base)。传递此标志将覆盖 `astro.config.mjs` 文件中的 `base` 值（如果存在）。

### `--port <number>`

指定运行开发服务器和预览服务器的端口。默认为 `4321`。

### `--host [optional host address]`

设置开发服务器和预览服务器应监听的网络 IP 地址（即非 localhost IP）。这在开发过程中对于在本地设备（如手机）上测试你的项目非常有用。

- `--host` — 在所有地址上监听，包括 LAN 和公共地址
- `--host <custom-address>` — 在 `<custom-address>` 的网络 IP 地址上公开

:::caution
不要在生产环境中使用 `--host` 标志来公开开发服务器和预览服务器。这些服务器仅设计用于在开发你的网站时本地使用。
:::


### `--verbose`

启用完整日志，调试时有用。

### `--silent`

启用静默日志，当你不想看到 Astro 日志时有用。

## 全局标志

使用这些标志获取有关 `astro` CLI 的信息。

### `--version`

打印 Astro 版本号并退出。

### `--open`

在服务器启动时自动在浏览器中打开应用程序。可以传递完整的 URL 字符串 (例如 `--open http://example.com`) 或路径名 (例如 `--open /about`) 来指定要打开的 URL。

### `--help`

打印帮助信息并退出。


## 高级 API（实验性）

如果你需要在运行 Astro 时获得更多的控制权，`"astro"` 包也导出了 API 来以编程方式运行 CLI 命令。

这些 API 是实验性的，它们的 API 签名可能会改变。任何更新都将在 [Astro 更新日志](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md) 中提到，下面的信息将始终显示当前的、最新的信息。

### `AstroInlineConfig`

`AstroInlineConfig` 类型由下面所有的命令 API 使用。它继承了用户的 [Astro 配置](/zh-cn/reference/configuration-reference/) 类型：

```ts
interface AstroInlineConfig extends AstroUserConfig {
	configFile?: string | false;
	mode?: "development" | "production";
	logLevel?: "debug" | "info" | "warn" | "error" | "silent";
}
```

#### `configFile`

<p>

**类型：** `string | false`<br />
**默认值：** `undefined`
</p>

一个自定义的 Astro 配置文件路径。

如果这个值是 undefined 的（默认）或未设置的，Astro 将在 `root` 目录下搜索 `astro.config.(js,mjs,ts)` 文件，并在找到时加载配置文件。

如果设置了相对路径，它将基于当前工作目录解析。

设置为 `false` 以禁用加载任何配置文件。

当与加载的用户配置合并时，传递给此对象的内联配置将具有最高优先级。

#### `mode`

<p>

**类型：** `"development" | "production"`<br />
**默认值：** 当运行 `astro dev` 时为 `"development"` , 当运行 `astro build` 时为 `"production"`
</p>

构建你的网站以生成“development”或“production”代码时使用的模式。

#### `logLevel`

<p>

**类型：** `"debug" | "info" | "warn" | "error" | "silent"`<br />
**默认值：** `"info"`
</p>

Astro 记录的消息的日志级别。

- `"debug"`: 记录所有内容，包括干扰调试诊断。
- `"info"`: 记录信息类型的消息，警告，和错误等日志。
- `"warn"`: 记录警告和错误日志。
- `"error"`: 只记录错误日志。
- `"silent"`: 不开启日志。

### `dev()`

**类型：** `(inlineConfig: AstroInlineConfig) => AstroDevServer`

和 [`astro dev`](#astro-dev) 类似，使用它来运行 Astro 的开发服务器。

```js
import { dev } from "astro";

const devServer = await dev({
  root: "./my-project",
});

// 在需要时停止服务器
await devServer.stop();
```

### `build()`

**类型：** `(inlineConfig: AstroInlineConfig) => void`

和 [`astro build`](#astro-build) 类似，使用它来构建你的网站以进行部署。

```js
import { build } from "astro";

await build({
  root: "./my-project",
});
```

### `preview()`

**类型：** `(inlineConfig: AstroInlineConfig) => AstroPreviewServer`

和 [`astro preview`](#astro-preview) 类似，它启动一个本地服务器为静态的 `dist/` 目录提供预览服务。

```js
import { preview } from "astro";

const previewServer = await preview({
  root: "./my-project",
});

// 在需要时停止服务器
await previewServer.stop();
```

### `sync()`

**类型：** `(inlineConfig: AstroInlineConfig) => number`

和 [`astro sync`](#astro-sync) 类似，它为所有 Astro 模块生成 TypeScript 类型。

```js
import { sync } from "astro";

const exitCode = await sync({
  root: "./my-project",
});

process.exit(exitCode)
```

## Astro Studio CLI

### `astro login`

通过 Astro Studio 进行身份验证。这对于运行所有数据库管理命令（包括 [`astro link`](#astro-link)）是必需的。

### `astro link`

连接到你的 Studio 托管数据库。这对于运行用于数据库管理的 [Astro DB 命令](/zh-cn/guides/integrations-guide/db/#astro-db-cli-参考)是必需的。要连接一个数据库，你会被提示选择一个已存在的数据库或创建一个新的。

### `astro logout`

登出 Astro Studio 并移除任何本地存储的身份验证密钥。